/*
    * $Header: /usr/local/cvsroot/dev/madcache/src/com/macvu/tiles/xmlDefinition/CacheDefinitionSaveFactory.java,v 1.3 2004/04/18 00:27:44 macvu Exp $
    * $Revision: 1.3 $
    * $Date: 2004/04/18 00:27:44 $
    *
    * ====================================================================
    *
    * The Apache Software License, Version 1.1
    *
   * Copyright (c) 1999-2002 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowlegement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Struts", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   *
   */
  package com.macvu.tiles.xmlDefinition;
  import com.macvu.tiles.CacheAttribute;
  import com.macvu.tiles.CacheComponentDefinition;
  import com.macvu.tiles.CacheInformation;
  import com.macvu.tiles.cache.CacheObjectWrapper;
  import org.apache.struts.tiles.ComponentDefinition;
  import org.apache.struts.tiles.DefinitionsFactoryException;
  import org.apache.struts.tiles.DefinitionsUtil;
  import org.jdom.Document;
  import org.jdom.Element;
  import org.jdom.JDOMException;
  import org.jdom.input.SAXBuilder;
  import org.jdom.output.Format;
  import org.jdom.output.XMLOutputter;
  import org.xml.sax.helpers.DefaultHandler;
  
  import javax.servlet.ServletContext;
  import javax.servlet.http.HttpServletRequest;
  import java.io.*;
  import java.util.ArrayList;
  import java.util.Iterator;
  import java.util.List;
  
  /***
   * Unfortunate that we have to do the saving in a separate Class from reading but we are hacking existing code in trying
   * to get the functionality as close to the orginial as possible.
   */
  public class CacheDefinitionSaveFactory {
      boolean initialized = false;
      List filenames;
  
      HttpServletRequest request;
      ServletContext servletContext;
  
      public CacheDefinitionSaveFactory() {
          initialized = false;
      }
  
      public void initDefintionFiles(HttpServletRequest request, ServletContext servletContext) {
         this.request = request;
         this.servletContext = servletContext;
 
         filenames = CacheObjectWrapper.getTileDefinitionFileList(servletContext);
         if (filenames == null) {
             throw new IllegalStateException("Tile definition has not been put into the servlet context yet.");
         }
 
         initialized = true;
     }
 
     public List getFilenames() {
         if (!initialized) {
             throw new IllegalStateException("call init definition files first");
         }
 
         return filenames;
     }
 
     public void setFilenames(List filenames) {
         this.filenames = filenames;
     }
 
     public void updateFile(String filename) {
         saveChangeToFile(filename, filename);
     }
 
     public void saveChangeToFile(String filename, String destination) {
         if (!initialized) {
             throw new IllegalStateException("call init definition files first");
         }
 
         try {
             FileInputStream ifileStream = new FileInputStream(servletContext.getRealPath(filename));
             FileOutputStream ofileStream = new FileOutputStream(destination);
 
             saveChange(ifileStream, ofileStream);
         } catch (FileNotFoundException e) {
             e.printStackTrace();  //To change body of catch statement use File | Settings | File Templates.
         }
     }
 
     public void saveChange(InputStream instream, OutputStream ostream) {
         if (!initialized) {
             throw new IllegalStateException("call init definition files first");
         }
 
         Document document;
         SAXBuilder parser = new SAXBuilder();
         parser.setValidation(false);
         parser.setDTDHandler(new DefaultHandler());
 
         try {
             document = parser.build(instream);
 
             Element root = document.getRootElement();
             List definitionList = root.getChildren();
             Iterator definitionItr = definitionList.iterator();
             while (definitionItr.hasNext()) {
                 Element definitionElement = (Element) definitionItr.next();
                 updateDefinitionElement(definitionElement);
             }
 
             ObjectOutputStream oStream = new ObjectOutputStream(ostream);
 
             XMLOutputter writer = new XMLOutputter(Format.getPrettyFormat());
             writer.output(document, oStream);
         } catch (JDOMException e) {
             e.printStackTrace();  //To change body of catch statement use File | Settings | File Templates.
         } catch (IOException e) {
             e.printStackTrace();  //To change body of catch statement use File | Settings | File Templates.
         }
 
     }
 
     private void updateDefinitionElement(Element definitionElement) {
         String tileName = definitionElement.getAttributeValue("name");
 
         ComponentDefinition definition;
 
         try {
             definition = DefinitionsUtil.getDefinition(tileName, request, servletContext);
             if (definition instanceof CacheComponentDefinition) {
                 CacheInformation cacheInfo = ((CacheComponentDefinition) definition).getCacheInformation();
                 if (cacheInfo == null || cacheInfo.isDefault()) {
                     definitionElement.removeChildren("cacheInformation");
                 } else {
                     Element cacheInformation = definitionElement.getChild("cacheInformation");
                     if (cacheInformation == null) {
                         cacheInformation = new Element("cacheInformation");
                         // definitionElement.getChildren().add(cacheInfo);
                     }
 
                     cacheInformation.setAttribute("cacheEnabled", String.valueOf(cacheInfo.getCacheEnabled()));
                     cacheInformation.setAttribute("repositoryName", cacheInfo.getRepositoryName());
                     cacheInformation.setAttribute("repositoryFactory", cacheInfo.getRepositoryFactory());
                     cacheInformation.setAttribute("keyFactory", cacheInfo.getKeyFactory());
 
                     addCacheKeysToCacheInformationElement(cacheInformation, cacheInfo.getCacheAttributes());
 
                     definitionElement.removeChild("cacheInformation");
                     definitionElement.addContent(cacheInformation);
                 }
             }
         } catch (DefinitionsFactoryException e) {
             // Unable to find definition.  Do Nothing.
         }
     }
 
     private void addCacheKeysToCacheInformationElement(Element cacheInformationElement, List cacheAttributes) {
         List list = new ArrayList();
 
         Iterator attIter = cacheAttributes.iterator();
 
         while (attIter.hasNext()) {
             CacheAttribute attr = (CacheAttribute) attIter.next();
             Element key = new Element("key");
             key.setAttribute("name", attr.getName());
             key.setAttribute("scope", attr.getScope());
 
             list.add(key);
         }
 
         cacheInformationElement.setContent(list);
     }
 }